feat(tutorials): add a getting-started/quickstart page - #53
Merged
Conversation
Adds a self-contained page (install + one runnable SUM(A1, B1) example, matching the truecalc-core README for consistency) so a visitor can go from zero to a running formula in under a minute, instead of clicking through several pages first. Linked from the homepage and made the first step of the beginner path. closes #51
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a self-contained "Getting started" tutorial page: install
@truecalc/core, run oneSUM(A1, B1)example, and pointers to Tutorials / Learn / Reference. Linked from the homepage and made the first step of the beginner path, so a new visitor can go from zero to a running formula in under a minute instead of clicking through several pages first.Closes #51
How to test
From the repo root:
Visit
http://localhost:3000/tutorials/getting-startedand confirm:SUM(A1, B1)example render correctly./tutorials,/tutorials/your-first-formula,/learn, and/referenceall resolve./) and/paths/beginnernow link to the new page as the first step.Or check the executable example directly:
which runs the page's
ts testblock (SUM(A1, B1)against{A1: 100, B1: 200}→300) along with every other Learn/Tutorial example.Review
Independent review: clean. No must-fix findings. Diff touches exactly the 4 in-scope files (new
content/docs/tutorials/getting-started.mdx, pluscontent/docs/index.mdx,content/docs/paths/beginner.mdx,content/docs/tutorials/meta.json); no generated-reference or fixture files touched.Test plan
npm run test-docs— 67/67 blocks passed, including the new page's examplenpm run build— static export succeeds; new page and all its outbound links resolve in the exportnpm run lint:enrichment— passesnpm run types:check— passesNeed help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.